<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.swiftworldserver;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import org.apache.log4j.Logger;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.codemonkey.swiftsocketclient.ClientMessageToServer;<a name="line.4"></a>
<FONT color="green">005</FONT>    import org.codemonkey.swiftsocketclient.SwiftSocketClient;<a name="line.5"></a>
<FONT color="green">006</FONT>    import org.codemonkey.swiftsocketclient.ServerMessageToClient;<a name="line.6"></a>
<FONT color="green">007</FONT>    import org.codemonkey.swiftsocketclient.ServerUtil;<a name="line.7"></a>
<FONT color="green">008</FONT>    import org.codemonkey.swiftsocketclient.UnknownMessageException;<a name="line.8"></a>
<FONT color="green">009</FONT>    <a name="line.9"></a>
<FONT color="green">010</FONT>    /**<a name="line.10"></a>
<FONT color="green">011</FONT>     * The World Client class adds a thin layer around the {@link SwiftSocketClient} to ease the management of a server-client interaction, or<a name="line.11"></a>
<FONT color="green">012</FONT>     * simulation / game state. It does not handle clients or connections, only client messages in the context of a specific world<a name="line.12"></a>
<FONT color="green">013</FONT>     * implementation.<a name="line.13"></a>
<FONT color="green">014</FONT>     * &lt;p&gt;<a name="line.14"></a>
<FONT color="green">015</FONT>     * The World Client allows us to execute decoded server messages against a known context (your game class for example), so that the<a name="line.15"></a>
<FONT color="green">016</FONT>     * executable message can then invoke specific methods on your {@link WorldContext} implementation.<a name="line.16"></a>
<FONT color="green">017</FONT>     * &lt;p&gt;<a name="line.17"></a>
<FONT color="green">018</FONT>     * This class keeps polling the client for unprocessed messages and executes them when they become available.<a name="line.18"></a>
<FONT color="green">019</FONT>     * <a name="line.19"></a>
<FONT color="green">020</FONT>     * @author Benny Bottema<a name="line.20"></a>
<FONT color="green">021</FONT>     * @param &lt;T&gt; A specific {@link WorldContext} implementation, such a some game or a simulation.<a name="line.21"></a>
<FONT color="green">022</FONT>     */<a name="line.22"></a>
<FONT color="green">023</FONT>    public final class WorldClient&lt;T extends WorldContext&gt; {<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>            private final Logger logger;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>            /**<a name="line.27"></a>
<FONT color="green">028</FONT>             * The client that we simply start and listen to for new messages. All registered message types are delegated to this client instance.<a name="line.28"></a>
<FONT color="green">029</FONT>             */<a name="line.29"></a>
<FONT color="green">030</FONT>            final SwiftSocketClient client;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>            /**<a name="line.32"></a>
<FONT color="green">033</FONT>             * The {@link WorldContext} implementation against which all executable messages are executed against.<a name="line.33"></a>
<FONT color="green">034</FONT>             */<a name="line.34"></a>
<FONT color="green">035</FONT>            private final T context;<a name="line.35"></a>
<FONT color="green">036</FONT>    <a name="line.36"></a>
<FONT color="green">037</FONT>            /**<a name="line.37"></a>
<FONT color="green">038</FONT>             * Starts a new default swift socket client on the given host and port, executing new messages as they become available.<a name="line.38"></a>
<FONT color="green">039</FONT>             * <a name="line.39"></a>
<FONT color="green">040</FONT>             * @param host The port on which the server should listen.<a name="line.40"></a>
<FONT color="green">041</FONT>             * @param port The port on which the server should listen.<a name="line.41"></a>
<FONT color="green">042</FONT>             * @param context The context on which client messages are executed against.<a name="line.42"></a>
<FONT color="green">043</FONT>             * @see SwiftSocketClient#SwiftSocketClient(String, int)<a name="line.43"></a>
<FONT color="green">044</FONT>             */<a name="line.44"></a>
<FONT color="green">045</FONT>            public WorldClient(final String host, final int port, final T context) {<a name="line.45"></a>
<FONT color="green">046</FONT>                    this.context = context;<a name="line.46"></a>
<FONT color="green">047</FONT>                    this.logger = Logger.getRootLogger();<a name="line.47"></a>
<FONT color="green">048</FONT>                    client = new SwiftSocketClient(host, port);<a name="line.48"></a>
<FONT color="green">049</FONT>            }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>            /**<a name="line.51"></a>
<FONT color="green">052</FONT>             * Registers a client-to-server message on the given unique identifier on the message socket client, by delegating to<a name="line.52"></a>
<FONT color="green">053</FONT>             * {@link SwiftSocketClient#registerClientMessageToServerType(int, Class)}.<a name="line.53"></a>
<FONT color="green">054</FONT>             * <a name="line.54"></a>
<FONT color="green">055</FONT>             * @param messageId The unique identifier for this message type.<a name="line.55"></a>
<FONT color="green">056</FONT>             * @param messageType A {@link ClientMessageToServer} sub type.<a name="line.56"></a>
<FONT color="green">057</FONT>             */<a name="line.57"></a>
<FONT color="green">058</FONT>            public void registerClientMessageToServerType(final int messageId, final Class&lt;? extends ClientMessageToServer&gt; messageType) {<a name="line.58"></a>
<FONT color="green">059</FONT>                    client.registerClientMessageToServerType(messageId, messageType);<a name="line.59"></a>
<FONT color="green">060</FONT>            }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>            /**<a name="line.62"></a>
<FONT color="green">063</FONT>             * Registers a server-to-client message on the given unique identifier on the message socket client, by delegating to<a name="line.63"></a>
<FONT color="green">064</FONT>             * {@link SwiftSocketClient#registerServerMessageToClientType(int, Class)}.<a name="line.64"></a>
<FONT color="green">065</FONT>             * <a name="line.65"></a>
<FONT color="green">066</FONT>             * @param messageId The unique identifier for this message type.<a name="line.66"></a>
<FONT color="green">067</FONT>             * @param messageType A {@link ServerMessageToClient} sub type.<a name="line.67"></a>
<FONT color="green">068</FONT>             */<a name="line.68"></a>
<FONT color="green">069</FONT>            public void registerServerMessageToClientId(final int messageId, final Class&lt;? extends ServerMessageToClient&lt;?&gt;&gt; messageType) {<a name="line.69"></a>
<FONT color="green">070</FONT>                    client.registerServerMessageToClientType(messageId, messageType);<a name="line.70"></a>
<FONT color="green">071</FONT>            }<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>            /**<a name="line.73"></a>
<FONT color="green">074</FONT>             * Calls {@link WorldContext#initWorld()} before starting the server, after which the server starts handling client connections and<a name="line.74"></a>
<FONT color="green">075</FONT>             * incoming messages.<a name="line.75"></a>
<FONT color="green">076</FONT>             */<a name="line.76"></a>
<FONT color="green">077</FONT>            @SuppressWarnings("unchecked")<a name="line.77"></a>
<FONT color="green">078</FONT>            public void start() {<a name="line.78"></a>
<FONT color="green">079</FONT>                    // 1. starting universe<a name="line.79"></a>
<FONT color="green">080</FONT>                    logger.info("loading universe...");<a name="line.80"></a>
<FONT color="green">081</FONT>                    context.initWorld();<a name="line.81"></a>
<FONT color="green">082</FONT>                    logger.info("universe loaded. Welcome.\n");<a name="line.82"></a>
<FONT color="green">083</FONT>    <a name="line.83"></a>
<FONT color="green">084</FONT>                    // 2. startup server<a name="line.84"></a>
<FONT color="green">085</FONT>                    client.start();<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>                    // 3. poll for new messages<a name="line.87"></a>
<FONT color="green">088</FONT>                    while (client.isRunning()) {<a name="line.88"></a>
<FONT color="green">089</FONT>                            if (client.hasServerResponses()) {<a name="line.89"></a>
<FONT color="green">090</FONT>                                    @SuppressWarnings("rawtypes")<a name="line.90"></a>
<FONT color="green">091</FONT>                                    final ServerMessageToClient response = client.getNextServerResponse();<a name="line.91"></a>
<FONT color="green">092</FONT>                                    try {<a name="line.92"></a>
<FONT color="green">093</FONT>                                            response.execute(context);<a name="line.93"></a>
<FONT color="green">094</FONT>                                    } catch (final UnknownMessageException e) {<a name="line.94"></a>
<FONT color="green">095</FONT>                                            logger.error("received invalid message from server");<a name="line.95"></a>
<FONT color="green">096</FONT>                                            logger.debug("\t\t" + e);<a name="line.96"></a>
<FONT color="green">097</FONT>                                    } catch (final Exception e) {<a name="line.97"></a>
<FONT color="green">098</FONT>                                            // severe error, but catch to prevent server from crashing<a name="line.98"></a>
<FONT color="green">099</FONT>                                            logger.error(String.format("error executing message '%s'", response));<a name="line.99"></a>
<FONT color="green">100</FONT>                                            logger.debug("\t\t" + e);<a name="line.100"></a>
<FONT color="green">101</FONT>                                    }<a name="line.101"></a>
<FONT color="green">102</FONT>                            } else {<a name="line.102"></a>
<FONT color="green">103</FONT>                                    ServerUtil.defaultSleep();<a name="line.103"></a>
<FONT color="green">104</FONT>                            }<a name="line.104"></a>
<FONT color="green">105</FONT>                    }<a name="line.105"></a>
<FONT color="green">106</FONT>            }<a name="line.106"></a>
<FONT color="green">107</FONT>    <a name="line.107"></a>
<FONT color="green">108</FONT>            /**<a name="line.108"></a>
<FONT color="green">109</FONT>             * @see SwiftSocketClient#stop()<a name="line.109"></a>
<FONT color="green">110</FONT>             */<a name="line.110"></a>
<FONT color="green">111</FONT>            public void stop() {<a name="line.111"></a>
<FONT color="green">112</FONT>                    client.stop();<a name="line.112"></a>
<FONT color="green">113</FONT>            }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>            /**<a name="line.115"></a>
<FONT color="green">116</FONT>             * @param serverMessage The message to send to the client associated with it.<a name="line.116"></a>
<FONT color="green">117</FONT>             * @see SwiftSocketClient#sendMessage(ClientMessageToServer)<a name="line.117"></a>
<FONT color="green">118</FONT>             */<a name="line.118"></a>
<FONT color="green">119</FONT>            public void sendMessage(final ClientMessageToServer serverMessage) {<a name="line.119"></a>
<FONT color="green">120</FONT>                    client.sendMessage(serverMessage);<a name="line.120"></a>
<FONT color="green">121</FONT>            }<a name="line.121"></a>
<FONT color="green">122</FONT>    }<a name="line.122"></a>




























































</PRE>
</BODY>
</HTML>
